RichEdit Procedures

The RichEdit procedures provides detailed descriptions of various procedures related to Rich Edit controls in Windows. It includes a table with procedure names and their descriptions, followed by detailed explanations of each procedure, including their parameters, return values, and usage examples. The procedures cover a wide range of functionalities such as URL detection, autocorrect, clipboard operations, undo/redo actions, character formatting, and various other features and settings for Rich Edit controls.

RichEdit Helper Procedures

RichEdit_AutoUrlDetect

Enables or disables automatic detection of URLs by a rich edit control.

FUNCTION RichEdit_AutoUrlDetect (BYVAL hRichEdit AS HWND, BYVAL fUrlDetect AS LONG) AS LONG

Return value

If the message succeeds, the return value is zero.

If the message fails, the return value is a nonzero value. For example, the message might fail due to insufficient memory or an invalid detection option.

Remarks

If automatic URL detection is enabled (that is, fUrlDetect includes AURL_ENABLEURL), the rich edit control scans any modified text to determine whether the text matches the format of a URL (or more generally in Windows 8 or later an IRI International Resource Identifier). The control detects URLs that begin with the following scheme names:

• callto
• file
• ftp
• gopher
• http
• https
• mailto
• news
• notes
• nntp
• onenote
• outlook
• prospero
• tel
• telnet
• wais
• webcal

When automatic link detection is enabled, the rich edit control removes the CFE_LINK effect from modified text that does not have a format recognized by the control. If your application uses the CFE_LINK effect to mark other types of text, do not enable automatic link detection. The rich edit control does not check whether a detected link exists; that responsibility belongs to the client.

A rich edit control sends the EN_LINK notification when it receives various messages while the mouse pointer is over text that has the CFE_LINK effect.

RichEdit_CallAutocorrectProc

Calls the autocorrect callback function that is stored by the RichEdit_SetAutocorrectProc message, provided that the text preceding the insertion point is a candidate for autocorrection.

FUNCTION RichEdit_CallAutocorrectProc (BYVAL hRichEdit AS HWND, BYVAL char AS WCHAR) AS LONG

Return value

The return value is zero if the message succeeds, or nonzero if an error occurs.

RichEdit_CanPaste

Determines whether a rich edit control can paste a specified clipboard format.

FUNCTION RichEdit_CanPaste (BYVAL hRichEdit AS HWND, BYVAL clipformat AS LONG) AS LONG

Return value

If the clipboard format can be pasted, the return value is a nonzero value.

If the clipboard format cannot be pasted, the return value is zero.

RichEdit_CanRedo

Determines whether there are any actions in the rich control redo queue.

FUNCTION RichEdit_CanRedo (BYVAL hRichEdit AS HWND) AS LONG

Return value

If there are actions in the control redo queue, the return value is a nonzero value.

If the redo queue is empty, the return value is zero.

RichEdit_CanUndo

Determines whether there are any actions in the rich edit control undo queue.

FUNCTION RichEdit_CanUndo (BYVAL hRichEdit AS HWND) AS LONG

Return value

If there are actions in the control’s undo queue, the return value is nonzero.

If the undo queue is empty, the return value is zero.

RichEdit_CharFromPos

Gets information about the character closest to a specified point in the client area of a rich edit control.

FUNCTION RichEdit_CharFromPos (BYVAL hRichEdit AS HWND, BYVAL lppl AS POINTL PTR) AS LONG

Return value

The return value specifies the zero-based character index of the character nearest the specified point. The return value indicates the last character in the edit control if the specified point is beyond the last character in the control.

RichEdit_DisplayBand

Displays a portion of the contents of a rich edit control, as previously formatted for a device using the EM_FORMATRANGE message.

FUNCTION RichEdit_DisplayBand (BYVAL hRichEdit AS HWND, BYVAL lprc AS RECT PTR) AS LONG

Return value

If the operation succeeds, the return value is TRUE.

If the operation fails, the return value is FALSE.

Remarks

Text and Component Object Model (COM) objects are clipped by the rectangle. The application does not need to set the clipping region.

Banding is the process by which a single page of output is generated using one or more separate rectangles, or bands. When all bands are placed on the page, a complete image results. This approach is often used by raster printers that do not have sufficient memory or ability to image a full page at one time. Banding devices include most dot matrix printers as well as some laser printers.

RichEdit_EmptyUndoBuffer

Resets the undo flag of an edit control. The undo flag is set whenever an operation within the edit control can be undone.

SUB RichEdit_EmptyUndoBuffer (BYVAL hRichEdit AS HWND)

RichEdit_ExGetSel

Retrieves the starting and ending character positions of the selection in a rich edit control.

SUB RichEdit_ExGetSel (BYVAL hRichEdit AS HWND, BYVAL lpchr AS CHARRANGE PTR)

CHARRANGE structure

type _charrange field = 4
    cpMin as LONG
    cpMax as LONG
end type

type CHARRANGE as _charrange

Usage example

DIM chrRange AS CHARRANGE
RichEdit_ExGetSel(hRichEdit, @chrRange)

RichEdit_ExLimitText

Sets an upper limit to the amount of text the user can type or paste into a rich edit control.

SUB RichEdit_ExLimitText (BYVAL hRichEdit AS HWND, BYVAL dwLimit AS DWORD)

Remarks

The text limit set by the RichEdit_ExLimitText message does not limit the amount of text that you can stream into a rich edit control using the RichEdit_StreamIn message with the pedst parameter set to SF_TEXT. However, it does limit the amount of text that you can stream into a rich edit control using the RichEdit_StreamIn message with the pedst parameter set set to SF_RTF.

Before RichEdit_ExLimitText is called, the default limit to the amount of text a user can enter is 32,767 characters.

RichEdit_ExLineFromChar

Determines which line contains the specified character in a rich edit control.

FUNCTION RichEdit_ExLineFromChar (BYVAL hRichEdit AS HWND, BYVAL iIndex AS LONG) AS LONG

Return value

Returns the zero-based index of the line.

RichEdit_ExSetSel

Selects a range of characters or Component Object Model (COM) objects in a Microsoft Rich Edit control.

FUNCTION RichEdit_ExSetSel (BYVAL hRichEdit AS HWND, BYVAL lpcr AS CHARRANGE PTR) AS DWORD

CHARRANGE structure

type _charrange field = 4
    cpMin as LONG
    cpMax as LONG
end type

type CHARRANGE as _charrange

Return value

The return value is the selection that is actually set.

Usage example

DIM chrRange AS CHARRANGE = TYPE<CHARRANGE>(3, 12)
RichEdit_ExSetSel(hRichEdit, @chrRange)

RichEdit_FindText

Finds text within a rich edit control.

FUNCTION RichEdit_FindText (BYVAL hRichEdit AS HWND, BYVAL fOptions AS DWORD, BYVAL lpft AS FINDTEXTW PTR) AS LONG

Return value

If the target string is found, the return value is the zero-based position of the first character of the match. If the target is not found, the return value is -1.

RichEdit_FindTextEx

Finds Unicode text within a rich edit control.

FUNCTION RichEdit_FindTextEx (BYVAL hRichEdit AS HWND, BYVAL fOptions AS DWORD, BYVAL lpftexw AS FINDTEXTEXW PTR) AS LONG

Return value

If the target string is found, the return value is the zero-based position of the first character of the match. If the target is not found, the return value is -1.

Remarks

RichEdit_FindTextEx uses the FINDTEXTEXW structure, while RichEdit_FindText uses the FINDTEXTW structure. The difference is that EM_FINDTEXTEXW reports the range of text that was found.

RichEdit_FindWordBreak

Finds the next word break before or after the specified character position or retrieves information about the character at that position.

FUNCTION RichEdit_FindWordBreak (BYVAL hRichEdit AS HWND, BYVAL fOperation AS DWORD, BYVAL dwStartPos AS DWORD) AS DWORD
   FUNCTION = SendMessageW(hRichEdit, EM_FINDWORDBREAK, fOperation, dwStartPos)
END FUNCTION

Return value

The message returns a value based on the fOperation parameter.

Remarks

If fOperation is WB_LEFT and WB_RIGHT, the word-break procedure finds word breaks only after delimiters. This matches the functionality of an edit control. If fOperation is WB_MOVEWORDLEFT or WB_MOVEWORDRIGHT, the word-break procedure also compares character classes and word-break flags.

For information about character classes and word-break flags, see Word and Line Breaks.

RichEdit_FormatRange

Formats a range of text in a rich edit control for a specific device.

FUNCTION RichEdit_FormatRange (BYVAL hRichEdit AS HWND, BYVAL fRender AS LONG, BYVAL lpfr AS FORMATRANGE PTR) AS DWORD

Return value

This message returns the index of the last character that fits in the region, plus 1.

Remarks

This message is typically used to format the content of rich edit control for an output device such as a printer.

After using this message to format a range of text, it is important that you free cached information by sending EM_FORMATRANGE again, but with lParam set to NULL; otherwise, a memory leak will occur. Also, after using this message for one device, you must free cached information before using it again for a different device.

RichEdit_GetAutoCorrectProc

Gets a pointer to the application-defined AutoCorrectProc callback function.

FUNCTION RichEdit_GetAutoCorrectProc (BYVAL hRichEdit AS HWND) AS LONG_PTR

Return value

Returns a pointer to the application-defined AutoCorrectProc callback function.

RichEdit_GetAutoUrlDetect

Indicates whether the auto URL detection is turned on in the rich edit control.

FUNCTION RichEdit_GetAutoUrlDetect (BYVAL hRichEdit AS HWND) AS LONG

Return value

If auto-URL detection is active, the return value is 1.

If auto-URL detection is inactive, the return value is 0.

Remarks

When auto URL detection is on, Microsoft Rich Edit is constantly checking typed text for a valid URL. Rich Edit recognizes URLs that start with these prefixes:

• http:
• file:
• mailto:
• ftp:
• https:
• gopher:
• nntp:
• prospero:
• telnet:
• news:
• wais:
• outlook:

Rich Edit also recognizes standard path names that start with \. When Rich Edit locates a URL, it changes the URL text color, underlines the text, and notifies the client using EN_LINK.

RichEdit_GetBidiOptions

Indicates the current state of the bidirectional options in the rich edit control.

SUB RichEdit_GetBidiOptions (BYVAL hRichEdit AS HWND, BYVAL lpbo AS BIDIOPTIONS PTR)
   SendMessageW hRichEdit, EM_GETBIDIOPTIONS, 0, cast(LPARAM, lpbo)
END SUB

Remarks

This message sets the values of the wMask and wEffects members to the value of the current state of the bidirectional options in the rich edit control.

RichEdit_GetCharFormat

Determines the character formatting in a rich edit control.

FUNCTION RichEdit_GetCharFormat (BYVAL hRichEdit AS HWND, BYVAL fOption AS DWORD, BYVAL lpcf AS CHARFORMATW PTR) AS DWORD

Return value

This message returns the value of the dwMask member of the CHARFORMAT structure.

RichEdit_GetCTFModeBias

Retrieves the Text Services Framework mode bias values for a Microsoft Rich Edit control.

FUNCTION RichEdit_GetCTFModeBias (BYVAL hRichEdit AS HWND) AS LONG
   FUNCTION = SendMessageW(hRichEdit, EM_GETCTFMODEBIAS, 0, 0)
END FUNCTION

Return value

The current Text Services Framework mode bias value.

Remarks

To get the IME mode bias, call RichEdit_GetIMEModeBias.

RichEdit_GetCTFOpenStatus

Determines if the Text Services Framework (TSF) keyboard is open or closed.

FUNCTION RichEdit_GetCTFOpenStatus (BYVAL hRichEdit AS HWND) AS LONG

Return value

If the TSF keyboard is open, the return value is TRUE. Otherwise, it is FALSE.

RichEdit_GetEditStyle

Retrieves the current edit style flags.

FUNCTION RichEdit_GetEditStyle (BYVAL hRichEdit AS HWND) AS DWORD

Return value

Returns the current edit style flags, which can include one or more of the following values:

RichEdit_GetEditStyleEx

Retrieves the current extended edit style flags.

FUNCTION RichEdit_GetEditStyleEx (BYVAL hRichEdit AS HWND) AS DWORD

Return value

Returns the extended edit style flags, which can include one or more of the following values.

RichEdit_GetEllipsisMode

Retrieves the current ellipsis mode. When enabled, an ellipsis ( ) is displayed for text that doesn’t fit in the display window. The ellipsis is only used when the control is not active. When active, scroll bars are used to reveal text that doesn’t fit into the display window.

FUNCTION RichEdit_GetEllipsisMode (BYVAL hRichEdit AS HWND, BYVAL pmode AS DWORD PTR) AS DWORD

Return value

If pmode is not NULL, the return value equals TRUE; otherwise, the return value equals FALSE.

RichEdit_GetEllipsisState

Retrieves the current ellipsis state.

FUNCTION RichEdit_GetEllipsisState (BYVAL hRichEdit AS HWND) AS DWORD

Return value

The return value is TRUE if an ellipsis is being displayed and FALSE otherwise.

RichEdit_GetEventMask

Retrieves the event mask for a rich edit control. The event mask specifies which notification messages the control sends to its parent window.

FUNCTION RichEdit_GetEventMask (BYVAL hRichEdit AS HWND) AS DWORD

Return value

This message returns the event mask for the rich edit control.

RichEdit_GetFirstVisibleLine

Retrieves the zero-based index of the uppermost visible line in a multiline edit control. You can send this message to either an edit control or a rich edit control.

FUNCTION RichEdit_GetFirstVisibleLine (BYVAL hRichEdit AS HWND) AS LONG

Return value

The return value is the zero-based index of the uppermost visible line in a multiline edit control.

For single-line rich edit controls, the return value is zero.

RichEdit_GetHyphenateInfo

Retrieves information about hyphenation for a Microsoft Rich Edit control.

SUB RichEdit_GetHyphenateInfo (BYVAL hRichEdit AS HWND, BYVAL lphi AS HYPHENATEINFO PTR)

RichEdit_GetIMEColor

Retrieves the Input Method Editor (IME) composition color. This message is available only in Asian-language versions of the operating system.

FUNCTION RichEdit_GetIMEColor (BYVAL hRichEdit AS HWND, BYVAL rgCmpclr AS COMPCOLOR PTR) AS LONG

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

RichEdit_GetIMECompMode

Retrieves the current Input Method Editor (IME) mode for a rich edit control.

FUNCTION RichEdit_GetIMECompMode (BYVAL hRichEdit AS HWND) AS DWORD

Return value

The return value is one of the following values.

RichEdit_GetIMECompText

Retrieves the Input Method Editor (IME) composition text.

FUNCTION RichEdit_GetIMECompText (BYVAL hRichEdit AS HWND, BYVAL lpict AS IMECOMPTEXT PTR, BYVAL buffer AS ANY PTR) AS DWORD

Return value

If successful, the return value is the number of Unicode characters copied to the buffer. Otherwise, it is zero.

Remarks

This message only takes Unicode strings.

Security Warning: Be sure to have a buffer sufficient for the size of the input. Failure to do so could cause problems for your application.

RichEdit_GetIMEModeBias

Retrieves the Input Method Editor (IME) mode bias for a Microsoft Rich Edit control.

FUNCTION RichEdit_GetIMEModeBias (BYVAL hRichEdit AS HWND) AS DWORD

Return value

This message returns the current IME mode bias setting.

Remarks

To get the Text Services Framework mode bias, use RichEdit_GetCTFModeBias.

The application should call RichEdit_IsIME before calling this function.

RichEdit_GetIMEOptions

Retrieves the current Input Method Editor (IME) options. This message is available only in Asian-language versions of the operating system.

FUNCTION RichEdit_GetIMEOptions (BYVAL hRichEdit AS HWND) AS DWORD

Return value

This message returns one or more of the IME option flag values described in the RichEdit_SetIMEOptions message.

RichEdit_GetIMEProperty

Retrieves the property and capabilities of the Input Method Editor (IME) associated with the current input locale.

FUNCTION RichEdit_GetIMEProperty (BYVAL hRichEdit AS HWND, BYVAL figp AS DWORD) AS DWORD

Return value

Returns the property or capability value, depending on the value of the figp parameter.

Remarks

If figp is IGP_PROPERTY, it returns one or more of the following values.

If figp is IGP_UI, it returns one or more of the following values.

If figp is IGP_SETCOMPSTR, it returns one or more of the following values.

If figp is IGP_SELECT, it returns one or more of the following values.

If figp is IGP_GETIMEVERSION, it returns one or more of the following values.

This message is similar to ImmGetProperty, except that it uses the current input locale. The application should call RichEdit_IsIME before calling this function.

RichEdit_GetLangOptions

Retrieves a rich edit control’s option settings for Input Method Editor (IME) and Asian language support.

FUNCTION RichEdit_GetLangOptions (BYVAL hRichEdit AS HWND) AS DWORD

Return value

Returns the IME and Asian language settings, which can be zero or more of the following values.

Remarks

The IMF_AUTOFONT flag is set by default. The IMF_AUTOKEYBOARD and IMF_IMECANCELCOMPLETE flags are cleared by default.

RichEdit_GetLimitText

Retrieves the current text limit for an edit control. You can send this message to either an edit control or a rich edit control.

FUNCTION RichEdit_GetLimitText (BYVAL hRichEdit AS HWND) AS LONG

Return value

The return value is the text limit.

Remarks

The text limit is the maximum amount of text, in characters, that the control can contain. For ANSI text, this is the number of bytes; for Unicode text, this is the number of characters. Two documents with the same character limit will yield the same text limit, even if one is ANSI and the other is Unicode.

RichEdit_GetLine

Copies a line of text from a rich edit control.

FUNCTION RichEdit_GetLine (BYVAL hRichEdit AS HWND, BYVAL which AS DWORD) AS DWSTRING

Note: Before sending the EM_GETLINE message, the first word of the buffer has to be set to the size, in characters, of the buffer. The size in the first word is overwritten by the copied line.

Return value

A copy of the line.

RichEdit_GetLineCount

Retrieves the number of lines in a multiline rich edit control.

FUNCTION RichEdit_GetLineCount (BYVAL hRichEdit AS HWND) AS LONG

Return value

The return value is an integer specifying the total number of text lines in the multiline edit control or rich edit control. If the control has no text, the return value is 1. The return value will never be less than 1.

Remarks

The EM_GETLINECOUNT message retrieves the total number of text lines, not just the number of lines that are currently visible.

If the Wordwrap feature is enabled, the number of lines can change when the dimensions of the editing window change.

RichEdit_GetModify

Retrieves the state of a rich edit control’s modification flag. The flag indicates whether the contents of the rich edit control have been modified.

FUNCTION RichEdit_GetModify (BYVAL hRichEdit AS HWND) AS LONG

Return value

If the contents of edit control have been modified, the return value is nonzero; otherwise, it is zero.

Remarks

The system automatically clears the modification flag to zero when the control is created. If the user changes the control’s text, the system sets the flag to nonzero. You can send the RichEdit_SetModify message to the edit control to set or clear the flag.

RichEdit_GetOleInterface

Retrieves an IRichEditOle object that a client can use to access a rich edit control’s Component Object Model (COM) functionality.

FUNCTION RichEdit_GetOleInterface (BYVAL hRichEdit AS HWND, BYVAL ppObject AS IUnknown PTR PTR) AS LONG

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

RichEdit_GetOptions

Retrieves rich edit control options.

FUNCTION RichEdit_GetOptions (BYVAL hRichEdit AS HWND) AS DWORD

Return value

This message returns a combination of the current option flag values described in the RichEdit_SetOptions message.

RichEdit_GetPageRotate

Deprecated. Retrieves the text layout for a Microsoft Rich Edit control.

FUNCTION RichEdit_GetPageRotate (BYVAL hRichEdit AS HWND) AS DWORD

Return value

The current text layout. For a list of possible text layout values, see RichEdit_SetPageRotate.

RichEdit_GetParaFormat

Retrieves the paragraph formatting of the current selection in a rich edit control.

FUNCTION RichEdit_GetParaFormat (BYVAL hRichEdit AS HWND, BYVAL pParaFmt AS PARAFORMAT PTR) AS DWORD

Return value

This message returns the value of the dwMask member of the PARAFORMAT structure.

RichEdit_GetPasswordChar

Retrieves the password character that a rich edit control displays when the user enters text.

FUNCTION RichEdit_GetPasswordChar (BYVAL hRichEdit AS HWND) AS LONG

Return value

The return value specifies the character to be displayed in place of any characters typed by the user. If the return value is NULL, there is no password character, and the control displays the characters typed by the user.

Remarks

If an edit control is created with the ES_PASSWORD style, the default password character is set to an asterisk (*). If an edit control is created without the ES_PASSWORD style, there is no password character. To change the password character, send the RichEdit_SetPasswordChar message.

RichEdit_GetPunctuation

Retrieves the current punctuation characters for the rich edit control.

FUNCTION RichEdit_GetPunctuation (BYVAL hRichEdit AS HWND, BYVAL punctype AS DWORD, BYVAL lppunct AS PUNCTUATION PTR) AS LONG

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

RichEdit_GetRect

Retrieves the formatting rectangle of an edit control. The formatting rectangle is the limiting rectangle into which the control draws the text. The limiting rectangle is independent of the size of the edit-control window.

SUB RichEdit_GetRect (BYVAL hRichEdit AS HWND, BYVAL prc AS RECT PTR)

Remarks

You can modify the formatting rectangle of a multiline edit control by using the RichEdit_SeRect and RichEdit_SeRectNP messages.

Under certain conditions, RichEdit_GetRect might not return the exact values that RichEdit_SeRect and RichEdit_SeRectNP set it will be approximately correct, but it can be off by a few pixels.

The formatting rectangle does not include the selection bar, which is an unmarked area to the left of each paragraph. When clicked, the selection bar selects the line.

RichEdit_GetRedoName

Retrieves the type of the next action, if any, in the rich edit control’s redo queue.

FUNCTION RichEdit_GetRedoName (BYVAL hRichEdit AS HWND) AS LONG

Return value

If the redo queue for the control is not empty, the value returned is an UNDONAMEID enumeration value that indicates the type of the next action in the control’s redo queue.

If there are no redoable actions or the type of the next redoable action is unknown, the return value is zero.

UNDONAMEID enumeration

Remarks

The types of actions that can be undone or redone include typing, delete, drag-drop, cut, and paste operations. This information can be useful for applications that provide an extended user interface for undo and redo operations, such as a drop-down list box of redoable actions.

RichEdit_GetScrollPos

Retrieves the current scroll position of the edit control.

FUNCTION RichEdit_GetScrollPos (BYVAL hRichEdit AS HWND, BYVAL lppt AS POINT PTR) AS DWORD

Remarks

The values returned in the POINT structure are 16-bit values (even in the 32-bit wide fields).

RichEdit_GetSel

Retrieves the starting and ending character positions of the current selection in a rich edit control.

FUNCTION RichEdit_GetSel (BYVAL hRichEdit AS HWND, BYVAL pdwStartPos AS DWORD PTR, BYVAL pdwEndPos AS DWORD PTR) AS LONG

Return value

The return value is a zero-based value with the starting position of the selection in the LOWORD and the position of the first character after the last selected character in the HIWORD. If either of these values exceeds 65,535, the return value is -1.

It is better to use the values returned in pdwStartPos and pdwEndPos because they are full 32-bit values.

Remarks

If there is no selection, the starting and ending values are both the position of the caret.

You can also use the EM_EXGETSEL message to retrieve the same information. EM_EXGETSEL also returns starting and ending character positions as 32-bit values. A combination of the use of EM_EXGETSEL and EM_GETSELTEXT are used in the RichEdit_GetSelText function to retrieve the selected text as a DWSTRING.

RichEdit_GetSelText

Retrieves the currently selected text in a rich edit control.

FUNCTION RichEdit_GetSelText (BYVAL hRichEdit AS HWND) AS DWSTRING

Return value

The selected text as a DWSTRING (dynamic unicode string).

RichEdit_GetStoryType

Gets the story type.

FUNCTION RichEdit_GetStoryTpe (BYVAL hRichEdit AS HWND, BYVAL Index AS DWORD) AS DWORD

Return value

Returns the story type, which can be a client-defined custom value, or one of the following values:

RichEdit_GetTableParams

Retrieves the table parameters for a table row and the cell parameters for the specified number of cells.

FUNCTION RichEdit_GetTableParams (BYVAL hRichEdit AS HWND, BYVAL lptp AS TABLEROWPARMS PTR, _
   BYVAL lptcp AS TABLECELLPARMS PTR) AS DWORD

Return value

Returns S_OK if successful, or one of the following error codes.

Remarks

This message gets the table parameters for the row at the character position specified by the cpStartRow member of the TABLEROWPARMS structure, and the number of cells specified by the cCells member of the TABLECELLPARMS structure.

The character position specified by the cpStartRow member of the TABLEROWPARMS structure should be at the start of the table row, or at the end delimiter of the table row. If cpStartRow is set to 1, the character position is given by the current selection. In this case, position the selection at the end of the row (between the cell mark and the end delimiter of the table row), or select the row.

RichEdit_GetText

Retrieves the text from a rich edit control.

FUNCTION RichEdit_GetText (BYVAL hRichEdit AS HWND) AS DWSTRING

Remarks

The Windows API function GetWindowTextW can also be used to retrive the text of a rich edit control, but it cannot retrieve the text of a control in another application.

RichEdit_GetTextEx

Retrieves all of the text from the rich edit control in any particular code base you want.

FUNCTION RichEdit_GetTextEx (BYVAL hRichEdit AS HWND, BYVAL lpgtex AS GETTEXTEX PTR, BYVAL buffer AS ANY PTR) AS DWORD

Return value

The return value is the number of characters copied into the output buffer, not including the null terminator.

Remarks

If the size of the output buffer is less than the size of the text in the control, the edit control will copy text from its beginning and place it in the buffer until the buffer is full. A terminating null character will still be placed at the end of the buffer.

RichEdit_GetTextLength

Retrieves the length of all text in a rich edit control.

FUNCTION RichEdit_GetTextLength (BYVAL hRichEdit AS HWND) AS LONG

Return value

The return value is the length of the text in characters, not including the terminating null character.

Remarks

When the WM_GETTEXTLENGTH message is sent, the DefWindowProc function returns the length, in characters, of the text. Under certain conditions, the DefWindowProc function returns a value that is larger than the actual length of the text. This occurs with certain mixtures of ANSI and Unicode, and is due to the system allowing for the possible existence of double-byte character set (DBCS) characters within the text. The return value, however, will always be at least as large as the actual length of the text; you can thus always use it to guide buffer allocation. This behavior can occur when an application uses both ANSI functions and common dialogs, which use Unicode.

To retrieve the text, you can also use the AfxGetWindowText function, the WM_GETTEXT message, or the Windows API GetWindowTextW function.

RichEdit_GetTextLengthEx

Calculates text length in various ways. It is usually called before creating a buffer to receive the text from the control.

FUNCTION RichEdit_GetTextLengthEx (BYVAL hRichEdit AS HWND, BYVAL lpgtex AS GETTEXTLENGTHEX PTR) AS LONG

Return value

The message returns the number of characters in the edit control, depending on the setting of the flags in the GETTEXTLENGTHEX structure. If incompatible flags were set in the flags member, the message returns E_INVALIDARG.

Remarks

This message is a fast and easy way to determine the number of characters in the Unicode version of the rich edit control. However, for a non-Unicode target code page you will potentially be converting to a combination of single-byte and double-byte characters.

RichEdit_GetTextMode

Retrieves the current text mode and undo level of a rich edit control.

FUNCTION RichEdit_GetTextMode (BYVAL hRichEdit AS HWND) AS DWORD

Return value

The return value is one or more values from the TEXTMODE enumeration type. The values indicate the current text mode and undo level of the control.

TEXTMODE enumeration

RichEdit_GetTextRange

Retrieves a specified range of characters from a rich edit control.

FUNCTION RichEdit_GetTextRange (BYVAL hRichEdit AS HWND, BYVAL lptrg AS TEXTRANGEW PTR) AS DWORD

Return value

The message returns the number of characters copied, not including the terminating null character.

RichEdit_GetThumb

Retrieves the position of the scroll box (thumb) in the vertical scroll bar of a multiline edit control.

FUNCTION RichEdit_GetThumb (BYVAL hRichEdit AS HWND) AS LONG

Return value

The return value is the position of the scroll box.

RichEdit_GetTouchOptions

Retrieves the touch options that are associated with a rich edit control.

FUNCTION RichEdit_GetTouchOptions (BYVAL hRichEdit AS HWND, BYVAL Options AS LONG PTR) AS DWORD

Return value

Returns the value of the option specified by the Options parameter. It is nonzero if Options is RTO_SHOWHANDLES and the touch grippers are visible; zero, otherwise.

RichEdit_GetTypographyOptions

Returns the current state of the typography options of a rich edit control.

FUNCTION RichEdit_GetTypographyOptions (BYVAL hRichEdit AS HWND) AS DWORD

Return value

Returns the current typography options. For a list of options, see EM_SETTYPOGRAPHYOPTIONS.

Remarks

You can turn on advanced line breaking by sending the RichEdit_SetTypographyOPtions message. Advanced and normal line breaking may also be turned on automatically by the rich edit control if it is needed for certain languages.

RichEdit_GetUndoName

Retrieves the type of the next undo action, if any.

FUNCTION RichEdit_GetUndoName (BYVAL hRichEdit AS HWND) AS DWORD

Return value

If there is an undo action, the value returned is an UNDONAMEID enumeration value that indicates the type of the next action in the control’s undo queue.

If there are no actions that can be undone or the type of the next undo action is unknown, the return value is zero.

UNDONAMEID enumeration

Remarks

The types of actions that can be undone or redone include typing, delete, drag, drop, cut, and paste operations. This information can be useful for applications that provide an extended user interface for undo and redo operations, such as a drop-down list box of actions that can be undone.

RichEdit_GetWordBreakProc

Retrieves the address of the current Wordwrap function.

FUNCTION RichEdit_GetWordBreakProc (BYVAL hRichEdit AS HWND) AS LONG_PTR

Return value

The return value specifies the address of the application-defined Wordwrap function. The return value is NULL if no Wordwrap function exists.

Remarks

A Wordwrap function scans a text buffer that contains text to be sent to the display, looking for the first word that does not fit on the current display line. The wordwrap function places this word at the beginning of the next line on the display. A Wordwrap function defines the point at which the system should break a line of text for multiline edit controls, usually at a space character that separates two words.

RichEdit_GetWordBreakProcEx

Retrieves the address of the currently registered extended word-break procedure.

FUNCTION RichEdit_GetWordBreakProcEx (BYVAL hRichEdit AS HWND) AS LONG_PTR

Return value

The message returns the address of the currently registered extended word-break procedure.

RichEdit_GetWordWrapMode

Retrieves the current word wrap and word-break options for the rich edit control.

FUNCTION RichEdit_GetWordWrapMode (BYVAL hRichEdit AS HWND) AS DWORD

Return value

The message returns the current word wrap and word-break options.

Remarks

This message is supported only in Asian-language versions of Microsoft Rich Edit 1.0. It is not supported in any later versions of Rich Edit. This message must not be sent by the application-defined, word-break procedure.

RichEdit_GetZoom

Retrieves the current zoom ratio, which is always between 1/64 and 64.

FUNCTION RichEdit_GetZoom (BYVAL hRichEdit AS HWND, BYVAL pzNum AS DWORD PTR, BYVAL pzDen AS DWORD PTR) AS LONG

Return value

The message returns TRUE if message is processed, which it will be if both pzNum and pzDen are not NULL.

RichEdit_HideSelection

Hides or shows the selection in a rich edit control.

SUB RichEdit_HideSelection (BYVAL hRichEdit AS HWND, BYVAL fHide AS DWORD)

RichEdit_InsertImage

Replaces the selection with a blob that displays an image.

FUNCTION RichEdit_InsertImage (BYVAL hRichEdit AS HWND, BYVAL lpip AS RICHEDIT_IMAGE_PARAMETERS PTR) AS DWORD

Return value

Returns S_OK if successful, or one of the following error codes.

RichEdit_InsertTable

Inserts one or more identical table rows with empty cells.

FUNCTION RichEdit_InsertTable (BYVAL hRichEdit AS HWND, BYVAL lptp AS TABLEROWPARMS PTR, _
   BYVAL lptcp AS TABLECELLPARMS PTR) AS DWORD

Return value

Returns S_OK if the table is inserted, or an error code if not.

Remarks

If the cpStartRow member of the TABLEROWPARMS is –1, this message deletes the selected text (if any), and then inserts empty table rows with the row and cell parameters given by lptp^ and lptcp. It leaves the selection pointing to the start of the first cell in the first row. The client can then populate the table cells by pointing the selection (or an ITextRange) to the various cell end marks and inserting and formatting the desired text. Such text can include nested table rows. Alternatively, if the cpStartRow member of the TABLEROWPARMS is 0 or greater, table rows are inserted at the character position given by cpStartRow. This only changes the current selection if the table is inserted inside the selected text.

A Microsoft Rich Edit table consists of a sequence of table rows which, in turn, consist of sequences of paragraphs. A table row starts with the special two-character delimiter paragraph U+FFF9 U+000D and ends with the two-character delimiter paragraph U+FFFB U+000D. Each cell is terminated by the cell mark U+0007, which is treated as a hard end-of-paragraph mark just as U+000D (CR) is. The table row and cell parameters are treated as special paragraph formatting of the table-row delimiters. The formatting contains the information in the TABLEROWPARMS structure. The cell parameters given by the TABLECELLPARMS structure are stored in an expanded version of the tabs array. This format allows tables to be nested within other tables, up to fifteen levels deep.

RichEdit_IsIME

Determines if current input locale is an East Asian locale.

FUNCTION RichEdit_IsIME (BYVAL hRichEdit AS HWND) AS LONG

Return value

Returns TRUE if it is an East Asian locale. Otherwise, it returns FALSE.

RichEdit_LimitText

Sets the text limit of a rich edit control. The text limit is the maximum amount of text, in characters, that the user can type into the edit control.

SUB RichEdit_LimitText (BYVAL hRichEdit AS HWND, BYVAL chMax AS DWORD)

Return value

This message does not return a value.

Remarks

The RichEdit_LimitText message limits only the text the user can enter. It does not affect any text already in the edit control when the message is sent, nor does it affect the length of the text copied to the edit control by the RichEdit_SetText message. If an application uses the RichEdit_SetTExt message to place more text into an edit control than is specified in the RichEdit_LimitText message, the user can edit the entire contents of the edit control.

Note

RichEdit_LimitText ad RichEdit_SetLimitText are the same message.

RichEdit_LineFromChar

Retrieves the index of the line that contains the specified character index in a multiline rich edit control.

FUNCTION RichEdit_LineFromChar (BYVAL hRichEdit AS HWND, BYVAL index AS DWORD) AS LONG

Return value

The return value is the zero-based line number of the line containing the character index specified by index.

RichEdit_LineIndex

Retrieves the character index of the first character of a specified line in a multiline rich edit control.

FUNCTION RichEdit_LineIndex (BYVAL hRichEdit AS HWND, BYVAL nLine AS LONG) AS LONG

Return value

The return value is the character index of the line specified in the nLine parameter, or it is -1 if the specified line number is greater than the number of lines in the edit control.

RichEdit_LineLength

Retrieves the length, in characters, of a line in a rich edit control.

FUNCTION RichEdit_LineLength (BYVAL hRichEdit AS HWND, BYVAL index AS DWORD) AS LONG

Return value

If index is greater than the number of characters in the control, the return value is zero.

RichEdit_LineScroll

Scrolls the text in a multiline rich edit control.

FUNCTION RichEdit_LineScroll (BYVAL hRichEdit AS HWND, BYVAL y AS LONG) AS LONG

Return value

TRUE or FALSE.

Remarks

The control does not scroll vertically past the last line of text in the edit control. If the current line plus the number of lines specified by the y parameter exceeds the total number of lines in the edit control, the value is adjusted so that the last line of the edit control is scrolled to the top of the edit-control window.

RichEdit_PasteSpecial

Pastes a specific clipboard format in a rich edit control.

SUB RichEdit_PasteSpecial (BYVAL hRichEdit AS HWND, BYVAL clpfmt AS DWORD, BYVAL lprps AS REPASTESPECIAL PTR)
   SendMessageW hRichEdit, EM_PASTESPECIAL, clpfmt, cast(LPARAM, lprps)
END SUB

RichEdit_PosFromChar

Retrieves the client area coordinates of a specified character in a rich edit control.

SUB RichEdit_PosFromChar (BYVAL hRichEdit AS HWND, BYVAL pt AS POINTL PTR, BYVAL index as DWORD)

Remarks

A returned coordinate can be a negative value if the specified character is not displayed in the edit control’s client area. The coordinates are truncated to integer values.

If the character is a line delimiter, the returned coordinates indicate a point just beyond the last visible character in the line. If the specified index is greater than the index of the last character in the control, the control returns -1.

RichEdit_Reconversion

Invokes the Input Method Editor (IME) reconversion dialog box.

FUNCTION RichEdit_Reconversion (BYVAL hRichEdit AS HWND) AS DWORD

Return value

This message always returns zero.

RichEdit_Redo

Redoes the next action in the control’s redo queue.

FUNCTION RichEdit_Redo (BYVAL hRichEdit AS HWND) AS LONG

Return value

If the Redo operation succeeds, the return value is a nonzero value.

If the Redo operation fails, the return value is zero.

Remarks

To determine whether there are any actions in the control’s redo queue, send the RichEdit_CanRedo message.

RichEdit_ReplaceSel

Replaces the current selection in a rich edit control with the specified text.

SUB RichEdit_ReplaceSel (BYVAL hRichEdit AS HWND, BYVAL bCanBeUndone AS LONG, BYVAL pwszText AS WSTRING PTR)

Remarks

Use the RichEdit_ReplaceSel message to replace only a portion of the text in an edit control. To replace all of the text, use the RichEdit_SetText message or the SetWindowText Windows API function.

If there is no selection, the replacement text is inserted at the caret.

In a rich edit control, the replacement text takes the formatting of the character at the caret or, if there is a selection, of the first character in the selection.

RichEdit_RequestResize

Forces a rich edit control to send an EN_REQUESTRESIZE notification message to its parent window.

SUB RichEdit_RequestResize (BYVAL hRichEdit AS HWND)

Remarks

This message is useful during WM_SIZE processing for the parent of a bottomless rich edit control.

RichEdit_Scroll

Scrolls the text vertically in a multiline rich edit control.

FUNCTION RichEdit_Scroll (BYVAL hRichEdit AS HWND, BYVAL nAction AS LONG) AS LONG

Return value

If the message is successful, the HIWORD of the return value is TRUE, and the LOWORD is the number of lines that the command scrolls. The number returned may not be the same as the actual number of lines scrolled if the scrolling moves to the beginning or the end of the text. If the nAction parameter specifies an invalid value, the return value is FALSE.

Remarks

To scroll to a specific line or character position, use the RichEdit_LineScroll message. To scroll the caret into view, use the RichEdit_ScrollCaret message.

RichEdit_ScrollCaret

Scrolls the caret into view in a rich edit control.

SUB RichEdit_ScrollCaret (BYVAL hRichEdit AS HWND)

Return value

The return value is not meaningful.

RichEdit_SelectionType

Determines the selection type for a rich edit control.

FUNCTION RichEdit_SelectionType (BYVAL hRichEdit AS HWND) AS LONG

Return value

If the selection is not empty, the return value is a set of flags containing one or more of the following values.

Remarks

This message is useful during WM_SIZE processing for the parent of a bottomless rich edit control.

RichEdit_SetAutoCorrectProc

Sets a pointer to the application-defined AutoCorrectProc callback function.

FUNCTION RichEdit_SetAutoCorrectProc (BYVAL hRichEdit AS HWND, BYVAL pfn AS LONG_PTR) AS DWORD

Return value

If the operation succeeds, the return value is zero. If the operation fails, the return value is a nonzero value.

RichEdit_SetBidiOptions

Sets the current state of the bidirectional options in the rich edit control.

SUB RichEdit_SetBidiOptions (BYVAL hRichEdit AS HWND, BYVAL pOptions AS BIDIOPTIONS PTR)

Remarks

The rich edit control must be in plain text mode or RichEdit_SetBidiOptions will not do anything.

In plain text controls, RichEdit_SetBidiOptions automatically determines the paragraph direction and/or alignment based on the context rules. These rules state that the direction and/or alignment is derived from the first strong character in the control. A strong character is one from which text direction can be determined (see Unicode Standard version 2.0). The paragraph direction and/or alignment is applied to the default format.

RichEdit_SetBidiOptions only switches the default paragraph format to RTL (right to left) if it finds an RTL character.

RichEdit_SetBkgndColor

Sets the background color for a rich edit control.

FUNCTION RichEdit_SetBkgndColor (BYVAL hRichEdit AS HWND, BYVAL pSysColor AS DWORD, BYVAL pBkColor AS DWORD) AS DWORD

Return value

This message returns the original background color.

RichEdit_SetCharFormat

Sets character formatting in a rich edit control.

FUNCTION RichEdit_SetCharFormat (BYVAL hRichEdit AS HWND, BYVAL chfmt AS DWORD, BYVAL lpcf AS CHARFORMATW PTR) AS LONG

Formatting values

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

Remarks

If this message is sent more than once with the same parameters, the effect on the text is toggled. That is, sending the message once produces the effect, sending the message twice cancels the effect, and so forth.

RichEdit_SetCTFModeBias

Sets the Text Services Framework (TSF) mode bias for a rich edit control.

FUNCTION RichEdit_SetCTFModeBias (BYVAL hRichEdit AS HWND, BYVAL nModeBias AS LONG) AS LONG

Return value

If successful, the return value is the new TSF mode bias value. If unsuccessful, the return value is the old TSF mode bias value.

Remarks

When a Microsoft Rich Edit application uses TSF, it can select the TSF mode bias. This message sets the criteria by which an alternative choice appears at the top of the list for selection.

To get the mode bias for the Input Method Editor (IME), use RichEdit_GetModeBias.

RichEdit_SetCTFOpenStatus

Opens or closes the Text Services Framework (TSF) keyboard.

FUNCTION RichEdit_SetCTFOpenStatus (BYVAL hRichEdit AS HWND, BYVAL fTSFkbd AS LONG) AS DWORD

Return value

If successful, this message returns TRUE. If unsuccessful, this message returns FALSE.

RichEdit_SetEditStyle

Sets the current edit style flags.

FUNCTION RichEdit_SetEditStyle (BYVAL hRichEdit AS HWND, BYVAL fStyle AS LONG, BYVAL fMask AS LONG) AS DWORD

Return value

The return value is the state of the edit style flags after the rich edit control has attempted to implement your edit style changes. The edit style flags are a set of flags that indicate the current edit style.

RichEdit_SetEditStyleEx

Sets the current edit style flags for a rich edit control.

FUNCTION RichEdit_SetEditStyleEx (BYVAL hRichEdit AS HWND, BYVAL fStyle AS LONG, BYVAL fMask AS LONG) AS DWORD

Return value

The return value is the state of the edit style flags after the rich edit control has attempted to implement your edit style changes. The edit style flags are a set of flags that indicate the current edit style.

RichEdit_SetEllipsisMode

Sets the current ellipsis mode. When enabled, an ellipsis ( ) is displayed for text that doesn’t fit in the display window. The ellipsis is only used when the control isn’t active. When active, scroll bars are used to reveal text that doesn’t fit into the display window.

FUNCTION RichEdit_SetElipsisMode (BYVAL hRichEdit AS HWND, BYVAL fMode AS DWORD) AS DWORD

The bits for these values all fit in the ELLIPSIS_MASK.

RichEdit_SetEventMask

Sets the event mask for a rich edit control.

FUNCTION RichEdit_SetEventMask (BYVAL hRichEdit AS HWND, BYVAL fMask AS LONG) AS LONG

Rich Edit Control Event Mask Flags

The event mask specifies which notification codes a rich edit control sends to its parent window. The event mask can be none or a combination of these values.

Return value

This message returns the previous event mask.

Remarks

The default event mask is ENM_NONE in which case no notifications are sent to the parent window. You can retrieve and set the event mask for a rich edit control by using the RichEdit_GetEvenMask and RichEdit_SetEventMask messages.

RichEdit_SetFontSize

Sets the font size for the selected text.

FUNCTION RichEdit_SetFontSize (BYVAL hRichEdit AS HWND, BYVAL ptsize AS LONG) AS LONG

Return value

If no error occurred, the return value is TRUE.

If an error occurred, the return value is FALSE.

Remarks

You can easily get the font size by sending the RichdEdit_GetCharFormat message.

Rich Edit first adds ptsize to the current font size and then uses the resulting size and the following table to determine the rounding value.

If the resulting font size is not evenly divisible by the rounding value, the font size is then rounded to a number evenly divisible by the rounding value. So if the font size is less than or equal to 12, the rounding value will be 1. Similarly, if the font size is less than or equal to 28, the rounding value is 2. For values greater than 28, font sizes are rounded to the next band. So, the font size jumps to 36, 48, 72, 80. After 80, all rounding is done in increments of ten points.

The font size is rounded up or down depending on the sign of ptsize. If ptsize is positive, the rounding is always up. Otherwise, rounding is always down. So, if the current font size is 10 and ptsize is 3, the resulting font size would be 14 (10 + 3 = 13, which is not divisible by 2, so the size rounds up to 14). Conversely, if the current font size is 14 and ptsize is -3, the resulting font size would be 10 (14 - 3 = 11, which is not divisible by 2, so the size rounds down to 10).

The change is applied to each part of the selection. So, if some of the text is 10pt and some 20pt, after a call with ptsize set to 1, the font sizes become 11pt and 22pt, respectively.

Additional examples are shown in the following table.

RichEdit_SetHyphenateInfo

Sets the way a Microsoft Rich Edit control does hyphenation.

SUB RichEdit_SetHyphenateInfo (BYVAL hRichEdit AS HWND, BYVAL phinfo AS HYPHENATEINFO PTR)

RichEdit_SetIMEColor

Sets the Input Method Editor (IME) composition color.

FUNCTION RichEdit_SetIMEColor (BYVAL hRichEdit AS HWND, BYVAL pcompcolor AS COMPCOLOR PTR) AS LONG

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

Note

This message is supported only in Asian-language versions of Microsoft Rich Edit 1.0. It is not supported in any later versions.

RichEdit_SetIMEModeBias

Sets the Input Method Editor (IME) mode bias for a Microsoft Rich Edit control.

FUNCTION RichEdit_SetIMEModeBias (BYVAL hRichEdit AS HWND, BYVAL nModeBias AS LONG) AS LONG

Return value

This message returns the new IME mode bias setting.

Remarks

When the IME generates a list of alternative choices for a set of characters, this message sets the criteria by which some of the choices will appear at the top of the list.

To set the Text Services Framework (TSF) mode bias, use RichEdit_SetCTFModeBias.

The application should call RichEdit_IsIME before calling this function.

RichEdit_SetIMEOptions

Sets the Input Method Editor (IME) options.

FUNCTION RichEdit_SetIMEOptions (BYVAL hRichEdit AS HWND, BYVAL fCoop AS LONG, BYVAL fOptions AS LONG) AS LONG

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

Note

This message is supported only in Asian-language versions of Microsoft Rich Edit 1.0. It is not supported in any later versions.

RichEdit_SetLangOptions

Sets options for Input Method Editor (IME) and Asian language support in a rich edit control.

FUNCTION RichEdit_SetLangOptions (BYVAL hRichEdit AS HWND, BYVAL lgoptions AS LONG) AS DWORD

Return value

This message returns a value of 1.

Remarks

The RichEdit_SetLangOptions message controls the following:

• Automatic font binding.
• Automatic keyboard switching.
• Automatic font size adjustment.
• Use of user-interface default fonts instead of document default fonts.
• Notifications to client during IME composition.
• How IME aborts composition mode.
• Spell checking, autocorrect, and touch keyboard prediction.

This message sets the values of all language option flags. To change a subset of the flags, send the RichEdit-GetLangOptions message to get the current option flags, change the flags that you need to change, and then send the RichEdit_SetLangOptions message with the result.

RichEdit_SetLimitText

Sets the text limit of a rich edit control. The text limit is the maximum amount of text, in characters, that the user can type into the edit control.

SUB RichEdit_SetLimitText (BYVAL hRichEdit AS HWND, BYVAL chMax AS DWORD)

Remarks

The RichEdit_SetLimitText message limits only the text the user can enter. It does not affect any text already in the edit control when the message is sent, nor does it affect the length of the text copied to the edit control by the RichEdit_SetText message. If an application uses the RichEdit_SetText message to place more text into an edit control than is specified in the RichEdit_SetLimitText message, the user can edit the entire contents of the edit control.

Note

RichEdit_SetLimitText ad RichEdit_LimitText are the same message.

RichEdit_SetMargins

Sets the widths of the left and right margins for a rich edit control. The message redraws the control to reflect the new margins.

PRIVATE SUB RichEdit_SetMargins (BYVAL hRichEdit AS HWND, BYVAL nMargins AS LONG, BYVAL nWidth AS LONG)

RichEdit_SetLimitText ad RichEdit_LimitText are the same message.

RichEdit_SetModify

Sets or clears the modification flag for a rich edit control. The modification flag indicates whether the text within the rich edit control has been modified.

SUB RichEdit_SetModify (BYVAL hRichEdit AS HWND, BYVAL fModify AS LONG)

Remarks

The system automatically clears the modification flag to zero when the control is created. If the user changes the control’s text, the system sets the flag to nonzero. You can send the RichEdit_GetModify message to the edit control to retrieve the current state of the flag.

Rich Edit 1.0: Objects created without the REO_DYNAMICSIZE flag will lock in their extents when the modify flag is set to FALSE.

RichEdit_SetOleCallback

Gives a rich edit control an IRichEditOleCallback object that the control uses to get OLE-related resources and information from the client.

FUNCTION RichEdit_SetOleCallback (BYVAL hRichEdit AS HWND, BYVAL pCallback AS ANY PTR) AS LONG

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

RichEdit_SetOptions

Sets the options for a rich edit control.

FUNCTION RichEdit_SetOptions (BYVAL hRichEdit AS HWND, BYVAL fCoop AS LONG, BYVAL fOptions AS LONG) AS LONG

Return value

This message returns the current options of the edit control.

RichEdit_SetPageRotate

Deprecated. Sets the text layout for a Microsoft Rich Edit control.

FUNCTION RichEdit_SetPageRotate (BYVAL hRichEdit AS HWND, BYVAL txtlayout AS LONG) AS LONG

Return value

Return value is the new text layout value.

Remarks

This message sets the text layout for the entire document. However, embedded contents are not rotated and must be rotated separately by the application.

RichEdit_SetPalette

Changes the palette that a rich edit control uses for its display window.

SUB RichEdit_SetPalette (BYVAL hRichEdit AS HWND, BYVAL newPalette AS HPALETTE)

Remarks

The rich edit control does not check whether the new palette is valid.

RichEdit_SetParaFormat

Sets the paragraph formatting for the current selection in a rich edit control.

FUNCTION RichEdit_SetParaFormat (BYVAL hRichEdit AS HWND, BYVAL pfmt AS PARAFORMAT PTR) AS LONG

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

RichEdit_SetPasswordChar

Sets or removes the password character for a rich edit control. When a password character is set, that character is displayed in place of the characters typed by the user.

SUB RichEdit_SetPasswordChar (BYVAL hRichEdit AS HWND, BYVAL dwchar AS DWORD)

Return value

This message does not return a value.

Remarks

When an edit control receives the EM_SETPASSWORDCHAR message, the control redraws all visible characters using the character specified by the dwchar parameter. If dwchar is zero, the control redraws all visible characters using the characters typed by the user.

If an edit control is created with the ES_PASSWORD style, the default password character is set to an asterisk (). If an edit control is created without the ES_PASSWORD style, there is no password character. The ES_PASSWORD style is removed if an EM_SETPASSWORDCHAR message is sent with the dwchar* parameter set to zero.

Edit controls: Multiline edit controls do not support the password style or messages.

Rich Edit: Supported in Microsoft Rich Edit 2.0 and later. Both single-line and multiline edit controls support the password style and messages.

RichEdit_SetPunctuation

Sets the punctuation characters for a rich edit control.

FUNCTION RichEdit_SetPunctuation (BYVAL hRichEdit AS HWND, BYVAL punctype AS LONG, BYVAL ppunct AS PUNCTUATION PTR) AS LONG

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

Note

This message is supported only in Asian-language versions of Microsoft Rich Edit 1.0. It is not supported in any later versions.

RichEdit_SetReadOnly

Sets or removes the read-only style (ES_READONLY) of a rich edit control.

FUNCTION RichEdit_SetReadOnly (BYVAL hRichEdit AS HWND, BYVAL fReadOnly AS LONG) AS LONG

Return value

If the operation succeeds, the return value is nonzero.

If the operation fails, the return value is zero.

Remarks

When an edit control has the ES_READONLY style, the user cannot change the text within the edit control.

To determine whether an edit control has the ES_READONLY style, use the Windows API GetWindowLong function with the GWL_STYLE flag.

Rich Edit: Supported in Microsoft Rich Edit 1.0 and later.

RichEdit_SetRect

Sets the formatting rectangle of a multiline rich edit control.

SUB RichEdit_SetRect (BYVAL hRichEdit AS HWND, BYVAL fCoord AS LONG, BYVAL prect AS RECT PTR)

Remarks

Setting prect to NULL has no effect if a touch device is installed, or if EM_SETRECT is sent from a thread that has a hook installed (see SetWindowsHookEx). In these cases, prect should contain a valid pointer to a RECT structure.

The EM_SETRECT message causes the text of the edit control to be redrawn. To change the size of the formatting rectangle without redrawing the text, use the EM_SETRECTNP message.

When an edit control is first created, the formatting rectangle is set to a default size. You can use the EM_SETRECT message to make the formatting rectangle larger or smaller than the edit control window.

If the edit control does not have a horizontal scroll bar, and the formatting rectangle is set to be larger than the edit control window, lines of text exceeding the width of the edit control window (but smaller than the width of the formatting rectangle) are clipped instead of wrapped.

If the edit control contains a border, the formatting rectangle is reduced by the size of the border. If you are adjusting the rectangle returned by an EM_GETRECT message, you must remove the size of the border before using the rectangle with the EM_SETRECT message.

Rich Edit: Supported in Microsoft Rich Edit 1.0 and later. The formatting rectangle does not include the selection bar, which is an unmarked area to the left of each paragraph. When the user clicks in the selection bar, the corresponding line is selected.

RichEdit_SetRectNP

Sets the formatting rectangle of a multiline rich edit control. The EM_SETRECTNP message is identical to the EM_SETRECT message, except that EM_SETRECTNP does not redraw the edit control window.

The formatting rectangle is the limiting rectangle into which the control draws the text. The limiting rectangle is independent of the size of the edit control window.

This message is processed only by multiline edit controls. You can send this message to either an edit control or a rich edit control.

SUB RichEdit_SetRectNP (BYVAL hRichEdit AS HWND, BYVAL fCoord AS LONG, BYVAL prect AS RECT PTR)

Remarks

Rich Edit: Supported in Microsoft Rich Edit 3.0 and later.

RichEdit_SetScrollPos

Scrolls the contents of a rich edit control to the specified point.

FUNCTION RichEdit_SetScrollPos (BYVAL hRichEdit AS HWND, BYVAL pt AS POINT PTR) AS DWORD

Return value

This message always returns 1.

RichEdit_SetSel

Selects a range of characters in an edit control.

SUB RichEdit_SetSel (BYVAL hRichEdit AS HWND, BYVAL nStart AS LONG, BYVAL nEnd AS LONG)

Remarks

The start value can be greater than the end value. The lower of the two values specifies the character position of the first character in the selection. The higher value specifies the position of the first character beyond the selection.

The start value is the anchor point of the selection, and the end value is the active end. If the user uses the SHIFT key to adjust the size of the selection, the active end can move but the anchor point remains the same.

If the start is 0 and the end is -1, all the text in the edit control is selected. If the start is -1, any current selection is deselected.

Edit controls: The control displays a flashing caret at the end position regardless of the relative values of start and end.

Rich Edit: Supported in Microsoft Rich Edit 1.0 and later.

If the edit control has the ES_NOHIDESEL style, the selected text is highlighted regardless of whether the control has focus. Without the ES_NOHIDESEL style, the selected text is highlighted only when the edit control has the focus.

RichEdit_SetStoryType

Sets the story type.

FUNCTION RichEdit_SetStoryType (BYVAL hRichEdit AS HWND, BYVAL Index AS LONG, BYVAL dwType AS DWORD) AS DWORD

Return value

The story type that was set.

RichEdit_SetTableParams

Changes the parameters of rows in a table.

FUNCTION RichEdit_SetTableParams (BYVAL hRichEdit AS HWND, BYVAL lptp AS TABLEROWPARMS PTR, _
   BYVAL lptcp AS TABLECELLPARMS PTR) AS DWORD

Return value

Returns S_OK if successful, or one of the following error codes.

Remarks

This message changes the parameters of the number of rows specified by the cRow member of the TABLEROWPARMS structure, if the table has that many consecutive rows. If cRow is less than 0, the message iterates until the end of the table. If the new cell count differs from the current cell count by +1 or 1, it inserts or deletes the cell at the index specified by the iCell member of TABLEROWPARMS. The starting table row is identified by a character position. This position is specified by cpStartRow members with values that are greater than or equal to zero. The position should be inside the table row, but not inside a nested table, unless you want to change that table s parameters. If the cpStartRow member is 1, the character position is given by the current selection. For this, position the selection anywhere inside the table row, or select the row with the active end of the selection at the end of the table row.

RichEdit_SetTabStops

Sets the tab stops in a multiline rich edit control. The EM_SETTABSTOPS message sets the tab stops in a multiline edit control. When text is copied to the control, any tab character in the text causes space to be generated up to the next tab stop. This message is processed only by multiline edit controls.

FUNCTION RichEdit_SetTabStops (BYVAL hRichEdit AS HWND, BYVAL nTabs AS LONG, BYVAL rgTabStops AS LONG_PTR) AS LONG

Return value

If all the tabs are set, the return value is TRUE.

If all the tabs are not set, the return value is FALSE.

Remarks

The EM_SETTABSTOPS message does not automatically redraw the edit control window. If the application is changing the tab stops for text already in the edit control, it should call the Windows API InvalidateRect function to redraw the edit control window.

The values specified in the array are in dialog template units, which are the device-independent units used in dialog box templates. To convert measurements from dialog template units to screen units (pixels), use the Windows API MapDialogRect function.

Rich Edit: Supported in Microsoft Rich Edit 3.0 and later. A rich edit control can have the maximum number of tab stops specified by MAX_TAB_STOPS.

RichEdit_SetTargetDevice

Sets the target device and line width used for WYSIWYG formatting in a rich edit control.

FUNCTION RichEdit_SetTargetDevice (BYVAL hRichEdit AS HWND, BYVAL hDC AS HDC, BYVAL lnwidth AS LONG) AS LONG

Return value

The return value is zero if the operation fails, or nonzero if it succeeds.

Remarks

The HDC for the default printer can be obtained as follows.

DIM hdc AS HDC
DIM pd AS PRINTDLGW
pd.lStructSize = SIZEOF(pd)
pd.flags = PD_RETURNDC OR PD_RETURNDEFAULT
IF PrintDlgW(@pd) THEN
   hdc =  = pd.hDC
END IF

If lnwidth is zero, no line breaks are created.

RichEdit_SetText

Sets the text of an edit control.

FUNCTION RichEdit_SetText (BYVAL hRichEdit AS HWND, BYVAL pwszText AS WSTRING PTR) AS LONG

Return value

The return value is TRUE if the text is set.

RichEdit_SetTextExW

Sets the text of an edit control. Combines the functionality of the WM_SETTEXT and EM_REPLACESEL messages, and adds the ability to set text using a code page and to use either rich text or plain text.

FUNCTION RichEdit_SetTextExW (BYVAL hRichEdit AS HWND, BYVAL pstex AS SETTEXTEX PTR, BYVAL pwszText AS WSTRING PTR) AS DWORD

Return value

If the operation is setting all of the text and succeeds, the return value is 1.

If the operation is setting the selection and succeeds, the return value is the number of bytes or characters copied.

If the operation fails, the return value is zero.

RichEdit_SetTextMode

Sets the text mode or undo level of a rich edit control. The message fails if the control contains any text.

FUNCTION RichEdit_SetTextMode (BYVAL hRichEdit AS HWND, BYVAL pvalues AS LONG) AS LONG

Specify one of the following values to set the text mode parameter. If you do not specify a text mode value, the text mode remains at its current setting.

Specify one of the following values to set the undo level parameter. If you do not specify an undo level value, the undo level remains at its current setting.

Specify one of the following values to set the code page parameter. If you do not specify an code page value, the code page remains at its current setting.

Return value

If the message succeeds, the return value is zero.

If the message fails, the return value is a nonzero value.

Remarks

In rich text mode, a rich edit control has standard rich edit functionality. However, in plain text mode, the control is similar to a standard edit control:

• The text in a plain text control can have only one format (such as Bold, 10pt Arial).
• The user cannot paste rich text formats, such as Rich Text Format (RTF) or embedded objects into a plain text control.
• Rich text mode controls always have a default end-of-document marker or carriage return, to format paragraphs. Plain text controls, on the other hand, do not need the default, end-of-document marker, so it is omitted.

The control must contain no text when it receives the RichEdit_SetText message. To ensure there is no text, send a RichEdit_SetText message with an empty string (““).

RichEdit_SetTouchOptions

Sets the touch options associated with a rich edit control.

SUB RichEdit_SetTouchOptions (BYVAL hRichEdit AS HWND, BYVAL Options AS LONG, BYVAL fEnable AS LONG)

RichEdit_SetTypographyOptions

Sets the current state of the typography options of a rich edit control.

FUNCTION RichEdit_SetTypographyOptions (BYVAL hRichEdit AS HWND, BYVAL pto AS LONG, BYVAL fMask AS LONG) AS LONG

Return value

Returns TRUE if pto is valid, otherwise FALSE.

Remarks

Advanced line breaking is turned on automatically by the rich edit control when needed, such as for handling complex scripts like Arabic and Hebrew, and for mathematics. It s also needed for justified paragraphs, hyphenation, and other typographic features.

RichEdit_SetUIAName

Sets the name of a rich edit control for UI Automation (UIA).

FUNCTION RichEdit_SetUIAName (BYVAL hRichEdit AS HWND, BYVAL pwszName AS WTRING PTR) AS DWORD

Return value

TRUE if the name for UIA is successfully set, otherwise FALSE.

RichEdit_SetUndoLimit

Sets the maximum number of actions that can stored in the undo queue of a rich edit control.

FUNCTION RichEdit_SetUndoLimit (BYVAL hRichEdit AS HWND, BYVAL maxactions AS DWORD) AS DWORD

Return value

The return value is the new maximum number of undo actions for the rich edit control. This value may be less than maxactions if memory is limited.

Remarks

By default, the maximum number of actions in the undo queue is 100. If you increase this number, there must be enough available memory to accommodate the new number. For better performance, set the limit to the smallest possible value.

Setting the limit to zero disables the Undo feature.

RichEdit_SetWordBreakProc

Replaces a rich edit control’s default Wordwrap function with an application-defined Wordwrap function.

SUB RichEdit_SetWordBreakProc (BYVAL hRichEdit AS HWND, BYVAL pfn AS LONG_PTR)

Remarks

A Wordwrap function scans a text buffer that contains text to be sent to the screen, looking for the first word that does not fit on the current screen line. The Wordwrap function places this word at the beginning of the next line on the screen.

A Wordwrap function defines the point at which the system should break a line of text for multiline edit controls, usually at a space character that separates two words. Either a multiline or a single-line edit control might call this function when the user presses arrow keys in combination with the CTRL key to move the caret to the next word or previous word. The default Wordwrap function breaks a line of text at a space character. The application-defined function may define the Wordwrap to occur at a hyphen or a character other than the space character.

Rich Edit: Supported in Microsoft Rich Edit 1.0 and later.

RichEdit_SetWordBreakProcEx

Sets the extended word-break procedure.

FUNCTION RichEdit_SetWordBreakProcEx (BYVAL hRichEdit AS HWND, BYVAL pfn AS LONG_PTR) AS LONG_PTR

Return value

This message returns the address of the previous extended word-break procedure.

RichEdit_SetWordWrapMode

Sets the word-wrapping and word-breaking options for a rich edit control.

FUNCTION RichEdit_SetWordWrapMode (BYVAL hRichEdit AS HWND, BYVAL values AS LONG) AS LONG

Return value

This message returns the current word-wrapping and word-breaking options.

Remarks

This message must not be sent by the application defined word breaking procedure.

RichEdit_SetZoom

Sets the zoom ratio for a multiline edit control or a rich edit control. The ratio must be a value between 1/64 and 64. The edit control needs to have the ES_EX_ZOOMABLE extended style set, for this message to have an effect, see Edit Control Extended Styles.

FUNCTION RichEdit_SetZoom (BYVAL hRichEdit AS HWND, BYVAL zNum AS DWORD, BYVAL zDen AS DWORD) AS LONG

Return value

If the new zoom setting is accepted, the return value is TRUE.

If the new zoom setting is not accepted, the return value is FALSE.

RichEdit_ShowScrollBar

Shows or hides one of the scroll bars in the host window of a rich edit control.

SUB RichEdit_ShowScrollBar (BYVAL hRichEdit AS HWND, BYVAL nScrollBar AS DWORD, BYVAL fShow AS LONG)

Remarks

This message is only valid when the control is in-place active. Calls made while the control is inactive may fail.

RichEdit_StopGroupTyping

Stops a rich edit control from collecting additional typing actions into the current undo action. The control stores the next typing action, if any, into a new action in the undo queue.

FUNCTION RichEdit_StopGroupTyping (BYVAL hRichEdit AS HWND) AS DWORD

Return value

The return value is zero. This message cannot fail.

Remarks

A rich edit control groups consecutive typing actions, including characters deleted by using the BackSpace key, into a single undo action until one of the following events occurs:

• The control receives an EM_STOPGROUPTYPING message.
• The control loses focus.
• The user moves the current selection, either by using the arrow keys or by clicking the mouse.
• The user presses the Delete key.
• The user performs any other action, such as a paste operation that does not involve typing.

You can send the RichEdit_StopGroupTyping message to break consecutive typing actions into smaller undo groups. For example, you could send RichEdit_StopGroupTyping after each character or at each word break.

RichEdit_StreamIn

Replaces the contents of a rich edit control with a stream of data provided by an application defined EditStreamCallback callback function.

FUNCTION RichEdit_StreamIn (BYVAL hRichEdit AS HWND, BYVAL psf AS LONG, BYVAL pedst AS EDITSTREAM PTR) AS DWORD

Data format and replacement options

In addition, you can specify the following flags.

Return value

This message returns the number of characters read.

Remarks

When you send an RichEdit_StreamIn message, the rich edit control makes repeated calls to the EditStreamCallback function specified by the pfnCallback member of the EDITSTREAM structure. Each time the callback function is called, it fills a buffer with data to read into the control. This continues until the callback function indicates that the stream-in operation has been completed or an error occurs.

RichEdit_StreamOut

Causes a rich edit control to pass its contents to an application defined EditStreamCallback callback function. The callback function can then write the stream of data to a file or any other location that it chooses.

FUNCTION RichEdit_StreamOut (BYVAL hRichEdit AS HWND, BYVAL psf AS LONG, BYVAL pedst AS EDITSTREAM PTR) AS DWORD

Data format and replacement options

The SF_RTFNOOBJS option is useful if an application stores COM objects itself, as RTF representation of COM objects is not very compact. The control word, , followed by a space denotes the object position.

In addition, you can specify the following flags.

Return value

This message returns the number of characters written to the data stream.

Remarks

When you send an RichEdit_StreamOut message, the rich edit control makes repeated calls to the EditStreamCallback function specified by the pfnCallback member of the EDITSTREAM structure. Each time it calls the callback function, the control passes a buffer containing a portion of the contents of the control. This process continues until the control has passed all its contents to the callback function, or until an error occurs.

RichEdit_Undo

This message undoes the last edit control operation in the control’s undo queue.

FUNCTION RichEdit_Undo (BYVAL hRichEdit AS HWND) AS LONG

Return value

For a single-line edit control, the return value is always TRUE.

For a multiline edit control, the return value is TRUE if the undo operation is successful, or FALSE if the undo operation fails.

Remarks

Edit controls and Rich Edit 1.0: An undo operation can also be undone. For example, you can restore deleted text with the first EM_UNDO message, and remove the text again with a second EM_UNDO message as long as there is no intervening edit operation.

Rich Edit 2.0 and later: The undo feature is multilevel so sending two EM_UNDO messages will undo the last two operations in the undo queue. To redo an operation, send the EM_REDO message.

Rich Edit: Supported in Microsoft Rich Edit 1.0 and later.

RichEdit_SetFont

Sets the font used by a rich edit control.

FUNCTION RichEdit_SetFont (BYVAL hRichEdit AS HWND, BYREF wszFaceName AS WSTRING, BYVAL ptsize AS LONG) AS LRESULT

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

RichEdit_LoadRtfFromFile

Loads the contents of a RTF file into a Rich Edit control.

FUNCTION RichEdit_LoadRtfFromFile (BYVAL hRichEdit AS HWND, BYREF wszFileName AS WSTRING) AS BOOLEAN

Return value

If the operation succeeds, the return value is TRUE.

If the operation fails, the return value is FALSE.

RichEdit_LoadRtfFromResource

Loads a RTF resource file into a Rich Edit control.

FUNCTION RichEdit_LoadRtfFromResourceW (BYVAL hRichEdit AS HWND, BYVAL hInstance AS HINSTANCE, _
   BYREF wszResourceName AS WSTRING) AS BOOLEAN

Return value

If the operation succeeds, the return value is TRUE.

If the operation fails, the return value is FALSE.

RichEdit_GetRtfText

Retrieves RTF formatted text from a Rich Edit control.

FUNCTION RichEdit_GetRtfText (BYVAL hRichEdit AS HWND) AS STRING

Return value

Returns the retrieved text or a null string.